vcFocusSet

Represents container for focus mode objects that is used to start Focus Mode feature. Content of the focus set will be kept focused, everything that is not included in the set will become unfocused when focus mode is started.

See in: Overview

Module: vcCore

Parent: vcObject

Children -

Referenced by: vcFocusModeManager.createFocusSet()

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
FocusedObjects	vcList	R	Gets collection of objects that this set contains.
IsActive	Boolean	R	Gets a value indicating whether this set is currently active in focus mode or not. True if this set is used in the active focus mode, false otherwise.
Name	String	RW	Gets or sets name of the focused object set.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
addObject	Boolean	vcNode objectToAdd	Adds objectToAdd to this set and returns result of the operation. See more Parameters: objectToAdd (vcNode): Node to add. Returns: bool: Returns True on success, otherwise False.
removeObject	Boolean	vcNode objectToRemove	Removes objectToRemove from this set and returns result of the operation. See more Parameters: objectToRemove (vcNode): Node to remove. Returns: bool: Returns True on success, otherwise False.

Events

Learn how to use events here. The events are also inherited from the parent class.

Name	Parameters	Description
ObjectAdded	None	Triggered when a new object was added to the set.
ObjectRemoved	None	Triggered when an object was removed from the set.